Skip to main content

Update Shipment

PUT /tms/shipments/{uuid}

Description​

This endpoint is used to update the details of a shipment.

Parameters​

  • tenantId (string, header, required): The tenant's unique identifier.
  • countryCode (string, header, required): The country code where the update is being made.
  • uuid (string, path, required): The unique identifier of the shipment.

Request Body​

  • Media Type: application/json

Example Value​

{
  "driverUserId": "string",
  "vehicleId": "string",
  "carrierId": "string",
  "carrierType": "string",
  "origin": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "destination": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "status": "string",
  "removeOrderIds": [
    "string"
  ],
  "addOrderIds": [
    "string"
  ]
}

Responses​

This section outlines the possible responses from the shipment update API.

Success Response (200)​

The Success Response (200) is returned when the shipment is successfully updated. This response indicates the success of the operation and provides additional details.

Response Fields​

FieldTypeDescription
statusbooleanIndicates the success of the shipment update request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the updated shipment details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example Value​

{
  "status": true,
  "statusCode": 0,
  "message": "Shipment updated",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Error Response (400)​

The Error Response (400) is returned when the request is invalid.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /tms/shipments/{uuid} \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!